Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update to add package documentation #1313

Merged
merged 8 commits into from Jan 22, 2019
Merged

Conversation

awentzel
Copy link
Collaborator

@awentzel awentzel commented Jan 17, 2019

Description

Adds Docusaurus configuration updates and a couple packages as placeholders for the automation to be added. This is incremental step to publish our package documentation since people are now asking forit.

  • Changed Documentation name to Guides to be more scalable as the site itself is Documentation so it could be confusing.
  • Updated Docusaurus configuration to support packages infrastructure (footer, header, index, sitenav)

Motivation & context

Solve inability to find package documentation without being in source code.

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@codeclimate
Copy link

codeclimate bot commented Jan 22, 2019

Code Climate has analyzed commit 785ec93 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 85.3% (0.0% change).

View more on Code Climate.

@awentzel awentzel merged commit 7a78666 into master Jan 22, 2019
@awentzel awentzel deleted the users/awentzel/doc-story branch January 22, 2019 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants